<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright 2001-2004 The Apache Software Foundation.<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.log4j.helpers;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
<span class="sourceLineNo">020</span>   This class used to output log statements from within the log4j package.<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>   &lt;p&gt;Log4j components cannot make log4j logging calls. However, it is<a name="line.22"></a>
<span class="sourceLineNo">023</span>   sometimes useful for the user to learn about what log4j is<a name="line.23"></a>
<span class="sourceLineNo">024</span>   doing. You can enable log4j internal logging by defining the<a name="line.24"></a>
<span class="sourceLineNo">025</span>   &lt;b&gt;log4j.configDebug&lt;/b&gt; variable.<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>   &lt;p&gt;All log4j internal debug calls go to &lt;code&gt;System.out&lt;/code&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span>   where as internal error messages are sent to<a name="line.28"></a>
<span class="sourceLineNo">029</span>   &lt;code&gt;System.err&lt;/code&gt;. All internal messages are prepended with<a name="line.29"></a>
<span class="sourceLineNo">030</span>   the string "log4j: ".<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>   @since 0.8.2<a name="line.32"></a>
<span class="sourceLineNo">033</span>   @author Ceki G&amp;uuml;lc&amp;uuml;<a name="line.33"></a>
<span class="sourceLineNo">034</span>*/<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class LogLog {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>    /**<a name="line.37"></a>
<span class="sourceLineNo">038</span>       Defining this value makes log4j print log4j-internal debug<a name="line.38"></a>
<span class="sourceLineNo">039</span>       statements to &lt;code&gt;System.out&lt;/code&gt;.<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>      &lt;p&gt; The value of this string is &lt;b&gt;log4j.debug&lt;/b&gt;.<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span>      &lt;p&gt;Note that the search for all option names is case sensitive.  */<a name="line.43"></a>
<span class="sourceLineNo">044</span>    public static final String DEBUG_KEY = "log4j.debug";<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>    /**<a name="line.46"></a>
<span class="sourceLineNo">047</span>       Defining this value makes log4j components print log4j-internal<a name="line.47"></a>
<span class="sourceLineNo">048</span>       debug statements to &lt;code&gt;System.out&lt;/code&gt;.<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>      &lt;p&gt; The value of this string is &lt;b&gt;log4j.configDebug&lt;/b&gt;.<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>      &lt;p&gt;Note that the search for all option names is case sensitive.<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>      @deprecated Use {@link #DEBUG_KEY} instead.<a name="line.54"></a>
<span class="sourceLineNo">055</span>    */<a name="line.55"></a>
<span class="sourceLineNo">056</span>    public static final String CONFIG_DEBUG_KEY = "log4j.configDebug";<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>    protected static boolean debugEnabled = false;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span>    /**<a name="line.60"></a>
<span class="sourceLineNo">061</span>       In quietMode not even errors generate any output.<a name="line.61"></a>
<span class="sourceLineNo">062</span>     */<a name="line.62"></a>
<span class="sourceLineNo">063</span>    private static boolean quietMode = false;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>    private static final String PREFIX = "log4j: ";<a name="line.65"></a>
<span class="sourceLineNo">066</span>    private static final String ERR_PREFIX = "log4j:ERROR ";<a name="line.66"></a>
<span class="sourceLineNo">067</span>    private static final String WARN_PREFIX = "log4j:WARN ";<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>    static {<a name="line.69"></a>
<span class="sourceLineNo">070</span>    }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>    /**<a name="line.72"></a>
<span class="sourceLineNo">073</span>       Allows to enable/disable log4j internal logging.<a name="line.73"></a>
<span class="sourceLineNo">074</span>     */<a name="line.74"></a>
<span class="sourceLineNo">075</span>    static public void setInternalDebugging(boolean enabled) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>        debugEnabled = enabled;<a name="line.76"></a>
<span class="sourceLineNo">077</span>    }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>    /**<a name="line.79"></a>
<span class="sourceLineNo">080</span>       This method is used to output log4j internal debug<a name="line.80"></a>
<span class="sourceLineNo">081</span>       statements. Output goes to &lt;code&gt;System.out&lt;/code&gt;.<a name="line.81"></a>
<span class="sourceLineNo">082</span>    */<a name="line.82"></a>
<span class="sourceLineNo">083</span>    public static void debug(String msg) {<a name="line.83"></a>
<span class="sourceLineNo">084</span>        if (debugEnabled &amp;&amp; !quietMode) {<a name="line.84"></a>
<span class="sourceLineNo">085</span>            System.out.println(PREFIX + msg);<a name="line.85"></a>
<span class="sourceLineNo">086</span>        }<a name="line.86"></a>
<span class="sourceLineNo">087</span>    }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>       This method is used to output log4j internal debug<a name="line.90"></a>
<span class="sourceLineNo">091</span>       statements. Output goes to &lt;code&gt;System.out&lt;/code&gt;.<a name="line.91"></a>
<span class="sourceLineNo">092</span>    */<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public static void debug(String msg, Throwable t) {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        if (debugEnabled &amp;&amp; !quietMode) {<a name="line.94"></a>
<span class="sourceLineNo">095</span>            System.out.println(PREFIX + msg);<a name="line.95"></a>
<span class="sourceLineNo">096</span>            if (t != null)<a name="line.96"></a>
<span class="sourceLineNo">097</span>                t.printStackTrace(System.out);<a name="line.97"></a>
<span class="sourceLineNo">098</span>        }<a name="line.98"></a>
<span class="sourceLineNo">099</span>    }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span>    /**<a name="line.101"></a>
<span class="sourceLineNo">102</span>       This method is used to output log4j internal error<a name="line.102"></a>
<span class="sourceLineNo">103</span>       statements. There is no way to disable error statements.<a name="line.103"></a>
<span class="sourceLineNo">104</span>       Output goes to &lt;code&gt;System.err&lt;/code&gt;.<a name="line.104"></a>
<span class="sourceLineNo">105</span>    */<a name="line.105"></a>
<span class="sourceLineNo">106</span>    public static void error(String msg) {<a name="line.106"></a>
<span class="sourceLineNo">107</span>        if (quietMode)<a name="line.107"></a>
<span class="sourceLineNo">108</span>            return;<a name="line.108"></a>
<span class="sourceLineNo">109</span>        System.err.println(ERR_PREFIX + msg);<a name="line.109"></a>
<span class="sourceLineNo">110</span>    }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>    /**<a name="line.112"></a>
<span class="sourceLineNo">113</span>       This method is used to output log4j internal error<a name="line.113"></a>
<span class="sourceLineNo">114</span>       statements. There is no way to disable error statements.<a name="line.114"></a>
<span class="sourceLineNo">115</span>       Output goes to &lt;code&gt;System.err&lt;/code&gt;.<a name="line.115"></a>
<span class="sourceLineNo">116</span>    */<a name="line.116"></a>
<span class="sourceLineNo">117</span>    public static void error(String msg, Throwable t) {<a name="line.117"></a>
<span class="sourceLineNo">118</span>        if (quietMode)<a name="line.118"></a>
<span class="sourceLineNo">119</span>            return;<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span>        System.err.println(ERR_PREFIX + msg);<a name="line.121"></a>
<span class="sourceLineNo">122</span>        if (t != null) {<a name="line.122"></a>
<span class="sourceLineNo">123</span>            t.printStackTrace();<a name="line.123"></a>
<span class="sourceLineNo">124</span>        }<a name="line.124"></a>
<span class="sourceLineNo">125</span>    }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span>    /**<a name="line.127"></a>
<span class="sourceLineNo">128</span>       In quite mode no LogLog generates strictly no output, not even<a name="line.128"></a>
<span class="sourceLineNo">129</span>       for errors.<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span>       @param quietMode A true for not<a name="line.131"></a>
<span class="sourceLineNo">132</span>    */<a name="line.132"></a>
<span class="sourceLineNo">133</span>    public static void setQuietMode(boolean quietMode) {<a name="line.133"></a>
<span class="sourceLineNo">134</span>        LogLog.quietMode = quietMode;<a name="line.134"></a>
<span class="sourceLineNo">135</span>    }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>    /**<a name="line.137"></a>
<span class="sourceLineNo">138</span>       This method is used to output log4j internal warning<a name="line.138"></a>
<span class="sourceLineNo">139</span>       statements. There is no way to disable warning statements.<a name="line.139"></a>
<span class="sourceLineNo">140</span>       Output goes to &lt;code&gt;System.err&lt;/code&gt;.  */<a name="line.140"></a>
<span class="sourceLineNo">141</span>    public static void warn(String msg) {<a name="line.141"></a>
<span class="sourceLineNo">142</span>        if (quietMode)<a name="line.142"></a>
<span class="sourceLineNo">143</span>            return;<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>        System.err.println(WARN_PREFIX + msg);<a name="line.145"></a>
<span class="sourceLineNo">146</span>    }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span>    /**<a name="line.148"></a>
<span class="sourceLineNo">149</span>       This method is used to output log4j internal warnings. There is<a name="line.149"></a>
<span class="sourceLineNo">150</span>       no way to disable warning statements.  Output goes to<a name="line.150"></a>
<span class="sourceLineNo">151</span>       &lt;code&gt;System.err&lt;/code&gt;.  */<a name="line.151"></a>
<span class="sourceLineNo">152</span>    public static void warn(String msg, Throwable t) {<a name="line.152"></a>
<span class="sourceLineNo">153</span>        if (quietMode)<a name="line.153"></a>
<span class="sourceLineNo">154</span>            return;<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span>        System.err.println(WARN_PREFIX + msg);<a name="line.156"></a>
<span class="sourceLineNo">157</span>        if (t != null) {<a name="line.157"></a>
<span class="sourceLineNo">158</span>            t.printStackTrace();<a name="line.158"></a>
<span class="sourceLineNo">159</span>        }<a name="line.159"></a>
<span class="sourceLineNo">160</span>    }<a name="line.160"></a>
<span class="sourceLineNo">161</span>}<a name="line.161"></a>




























































</pre>
</div>
</body>
</html>
